Merge branch 'dev' into somalaya/naaTestsWithMSA

changelog

@@ -1,6 +1,13 @@
 MSAL Wiki : https://github.com/AzureAD/microsoft-authentication-library-for-android/wiki
+
 vNext
 ----------
+- [MINOR] Add isQRPinAvailable API to MSAL IPublicClientApplication (#1931)
+- [MINOR] Add PreferredAuthMethod to interactive token flow (#1964)
+
+Version 5.0.0
+----------
+- [MINOR] Update common @17.0.0
 - [MINOR] Add consumer rule to remove native auth from msal by default (#1986)
 - [MAJOR] Consuming Credential Manager from common (brings minCompileSdk 34) (#1987)
 

msal/src/main/java/com/microsoft/identity/client/AcquireTokenParameters.java

@@ -25,8 +25,11 @@
 
 import android.app.Activity;
 
+import androidx.annotation.Nullable;
 import androidx.fragment.app.Fragment;
 
+import com.microsoft.identity.common.java.ui.PreferredAuthMethod;
+
 import java.util.List;
 import java.util.Map;
 
@@ -43,11 +46,14 @@ public class AcquireTokenParameters extends TokenParameters {
     private List<Map.Entry<String, String>> mExtraQueryStringParameters;
     private AuthenticationCallback mCallback;
 
+    private PreferredAuthMethod mPreferredAuthMethod;
+
     public AcquireTokenParameters(AcquireTokenParameters.Builder builder) {
         super(builder);
         mActivity = builder.mActivity;
         mFragment = builder.mFragment;
         mLoginHint = builder.mLoginHint;
+        mPreferredAuthMethod = builder.mPreferredAuthMethod;
         mPrompt = builder.mPrompt;
         mExtraScopesToConsent = builder.mExtraScopesToConsent;
         mExtraQueryStringParameters = builder.mExtraQueryStringParameters;
@@ -86,6 +92,15 @@ void setLoginHint(String loginHint) {
         this.mLoginHint = loginHint;
     }
 
+    /**
+     * Gets the preferred authentication method sent along with the authorization request.
+     * @return The preferred authentication method or null if not set.
+     */
+    @Nullable
+    public PreferredAuthMethod getPreferredAuthMethod() {
+        return mPreferredAuthMethod;
+    }
+
     /**
      * Controls the value of the prompt parameter sent along with the authorization request.
      *
@@ -137,6 +152,8 @@ public static class Builder extends TokenParameters.Builder<AcquireTokenParamete
         private Activity mActivity;
         private Fragment mFragment;
         private String mLoginHint;
+
+        private PreferredAuthMethod mPreferredAuthMethod;
         private Prompt mPrompt;
         private List<String> mExtraScopesToConsent;
         private List<Map.Entry<String, String>> mExtraQueryStringParameters;
@@ -157,6 +174,12 @@ public AcquireTokenParameters.Builder withLoginHint(String loginHint) {
             return self();
         }
 
+        @Nullable
+        public AcquireTokenParameters.Builder withPreferredAuthMethod(final PreferredAuthMethod preferredAuthMethod) {
+            mPreferredAuthMethod = preferredAuthMethod;
+            return self();
+        }
+
         public AcquireTokenParameters.Builder withPrompt(Prompt prompt) {
             mPrompt = prompt;
             return self();

msal/src/main/java/com/microsoft/identity/client/IPublicClientApplication.java

@@ -30,6 +30,7 @@
 
 import com.microsoft.identity.client.claims.ClaimsRequest;
 import com.microsoft.identity.client.exception.MsalException;
+import com.microsoft.identity.common.java.exception.BaseException;
 import com.microsoft.identity.common.java.util.TaskCompletedCallbackWithError;
 
 import java.util.Date;
@@ -144,6 +145,14 @@ void acquireToken(@NonNull final Activity activity,
      */
     boolean isSharedDevice();
 
+    /**
+     * Returns whether the application can support the QR code scanning + PIN protocol.
+     *
+     * @return true if the device supports the QR code scanning + PIN protocol, false otherwise.
+     * @throws BaseException if the broker is required but not installed.
+     */
+    boolean isQRPinAvailable() throws BaseException;
+
     /**
      * Signs the provided {@link PoPAuthenticationScheme} parameters into a JWT on behalf of the
      * provided {@link IAccount}.

msal/src/main/java/com/microsoft/identity/client/PublicClientApplication.java

@@ -88,6 +88,7 @@
 import com.microsoft.identity.common.internal.cache.SharedPreferencesFileManager;
 import com.microsoft.identity.common.internal.commands.GenerateShrCommand;
 import com.microsoft.identity.common.internal.commands.GetDeviceModeCommand;
+import com.microsoft.identity.common.internal.commands.IsQrPinAvailableCommand;
 import com.microsoft.identity.common.internal.controllers.LocalMSALController;
 import com.microsoft.identity.common.internal.migration.AdalMigrationAdapter;
 import com.microsoft.identity.common.internal.migration.TokenMigrationCallback;
@@ -105,21 +106,25 @@
 import com.microsoft.identity.common.java.commands.CommandCallback;
 import com.microsoft.identity.common.java.commands.DeviceCodeFlowCommand;
 import com.microsoft.identity.common.java.commands.DeviceCodeFlowCommandCallback;
+import com.microsoft.identity.common.java.commands.ICommandResult;
 import com.microsoft.identity.common.java.commands.InteractiveTokenCommand;
 import com.microsoft.identity.common.java.commands.SilentTokenCommand;
 import com.microsoft.identity.common.java.commands.parameters.CommandParameters;
 import com.microsoft.identity.common.java.commands.parameters.DeviceCodeFlowCommandParameters;
 import com.microsoft.identity.common.java.commands.parameters.GenerateShrCommandParameters;
 import com.microsoft.identity.common.java.commands.parameters.InteractiveTokenCommandParameters;
 import com.microsoft.identity.common.java.commands.parameters.SilentTokenCommandParameters;
+import com.microsoft.identity.common.java.controllers.BaseController;
 import com.microsoft.identity.common.java.controllers.CommandDispatcher;
+import com.microsoft.identity.common.java.controllers.CommandResult;
 import com.microsoft.identity.common.java.controllers.ExceptionAdapter;
 import com.microsoft.identity.common.java.dto.AccountRecord;
 import com.microsoft.identity.common.java.eststelemetry.PublicApiId;
 import com.microsoft.identity.common.java.exception.BaseException;
 import com.microsoft.identity.common.java.exception.ClientException;
 import com.microsoft.identity.common.java.exception.ErrorStrings;
 import com.microsoft.identity.common.java.exception.ServiceException;
+import com.microsoft.identity.common.java.exception.UserCancelException;
 import com.microsoft.identity.common.java.opentelemetry.AttributeName;
 import com.microsoft.identity.common.java.opentelemetry.OTelUtility;
 import com.microsoft.identity.common.java.opentelemetry.OtelContextExtension;
@@ -129,6 +134,7 @@
 import com.microsoft.identity.common.java.providers.microsoft.MicrosoftRefreshToken;
 import com.microsoft.identity.common.java.providers.microsoft.azureactivedirectory.AzureActiveDirectory;
 import com.microsoft.identity.common.java.providers.oauth2.OAuth2TokenCache;
+import com.microsoft.identity.common.java.result.FinalizableResultFuture;
 import com.microsoft.identity.common.java.result.GenerateShrResult;
 import com.microsoft.identity.common.java.result.ILocalAuthenticationResult;
 import com.microsoft.identity.common.java.result.LocalAuthenticationResult;
@@ -1463,6 +1469,68 @@ public boolean isSharedDevice() {
         return mPublicClientConfiguration.getIsSharedDevice();
     }
 
+    /**
+     * Returns whether the application supports the QR code scanning + PIN protocol.
+     *
+     * @return true if the device supports the QR code scanning + PIN protocol, false otherwise.
+     */
+    @Override
+    public boolean isQRPinAvailable() throws BaseException {
+        final String methodTag = TAG + ":isQRPinAvailable";
+
+        final CommandParameters params = CommandParametersAdapter.createCommandParameters(
+                mPublicClientConfiguration,
+                mPublicClientConfiguration.getOAuth2TokenCache()
+        );
+
+        final BaseController controller = new MSALControllerFactory(mPublicClientConfiguration)
+                .getDefaultController(CommandParametersAdapter.getRequestAuthority(mPublicClientConfiguration));
+
+        final IsQrPinAvailableCommand command = new IsQrPinAvailableCommand(
+                params,
+                controller,
+                new CommandCallback<Boolean, BaseException>() {
+                    @Override
+                    public void onError(BaseException error) {
+                        Logger.error(methodTag, "Unexpected error on isQRPinAvailable", error);
+                    }
+                    @Override
+                    public void onTaskCompleted(Boolean isQrPinAvailable) {
+                        Logger.info(methodTag, "is QR + PIN available? " + isQrPinAvailable );
+                    }
+                    @Override
+                    public void onCancel() {
+                        // Should not be reached.
+                    }
+                },
+                PublicApiId.PCA_IS_QR_PIN_AVAILABLE
+        );
+
+        final ResultFuture<CommandResult> future = CommandDispatcher.submitSilentReturningFuture(command);
+
+        try {
+            final CommandResult commandResult = future.get();
+            switch (commandResult.getStatus()) {
+                case COMPLETED:
+                    Logger.info(methodTag, "is QR + PIN available? " + commandResult.getResult());
+                    return (Boolean) commandResult.getResult();
+                case ERROR:
+                    final BaseException exception = (BaseException) commandResult.getResult();
+                    Logger.error(methodTag, "Unexpected error on isQRPinAvailable", exception);
+                    throw exception;
+                case CANCEL:
+                    Logger.warn(methodTag, "isQRPinAvailable was cancelled");
+                    return false;
+                default:
+                    Logger.warn(methodTag, "Unexpected status on isQRPinAvailable: " + commandResult.getStatus());
+                    return false;
+            }
+        } catch (final InterruptedException | ExecutionException e) {
+            Logger.error(methodTag, "Unexpected error on isQRPinAvailable", e);
+            return false;
+        }
+    }
+
     @Override
     public String generateSignedHttpRequest(@NonNull final IAccount account,
                                             @NonNull final PoPAuthenticationScheme popParameters) throws MsalException {