Add Native Auth V2 SMS MFA support, Fixes AB#3754593

msal/src/main/java/com/microsoft/identity/nativeauth/statemachine/states/MFARequiredStateV2.kt

@@ -61,9 +61,9 @@ import java.util.Collections
  *
  * No challenge is sent until the app selects a method explicitly. [authMethods] is exactly the set
  * the server offered for this step; selecting anything else fails without issuing a request. This
- * increment supports email one-time codes only, so any other channel returns a not-implemented
- * error ([com.microsoft.identity.nativeauth.statemachine.errors.NativeAuthErrorV2.isNotImplemented])
- * rather than following the wrong link.
+ * state supports email and SMS one-time codes; any other channel returns a not-implemented error
+ * ([com.microsoft.identity.nativeauth.statemachine.errors.NativeAuthErrorV2.isNotImplemented])
+ * rather than following an unsupported method.
  */
 class MFARequiredStateV2 internal constructor(
     continuationToken: String?,
@@ -162,13 +162,18 @@ class MFARequiredStateV2 internal constructor(
                 scenario = scenario
             )
 
-        if (!offeredMethod.challengeChannel.equals(NativeAuthConstants.ChallengeChannel.EMAIL, ignoreCase = true)) {
-            // Reported as not-implemented rather than a bare error so the app can tell "this SDK
-            // increment only supports email one-time codes" apart from an unspecified server error,
-            // which is what an untyped error would be indistinguishable from.
+        if (!offeredMethod.challengeChannel.equals(
+                NativeAuthConstants.ChallengeChannel.EMAIL,
+                ignoreCase = true
+            ) &&
+            !offeredMethod.challengeChannel.equals(
+                NativeAuthConstants.ChallengeChannel.SMS,
+                ignoreCase = true
+            )
+        ) {
             return MFARequestChallengeErrorV2(
                 errorType = ErrorTypes.NOT_IMPLEMENTED,
-                errorMessage = "Only email authentication methods are supported for multi-factor authentication.",
+                errorMessage = "Only email and SMS authentication methods are supported for multi-factor authentication.",
                 correlationId = correlationId,
                 scenario = scenario
             )

msal/src/test/java/com/microsoft/identity/nativeauth/v2/NativeAuthV2SignInTest.kt

@@ -473,6 +473,25 @@ class NativeAuthV2SignInTest : PublicClientApplicationAbstractTest() {
         assertEquals("email", result.authMethods.single().challengeChannel)
     }
 
+    @Test
+    fun submitFirstFactorEmailCodeCanTransitionToSmsMFA() = runTest {
+        val state = codeRequiredState()
+        enqueueResult(
+            NativeAuthV2CommandResult.MFARequired(
+                correlationId,
+                createContinuationState(),
+                listOf(NativeAuthV2AuthMethod("sms-1", "sms", "+X XXX XXX 34"))
+            ),
+            NativeAuthV2SignInSubmitCodeCommand::class
+        )
+
+        val result = state.submitCode("12345678") as NativeAuthResultV2.MFARequired
+
+        assertEquals(NativeAuthFlowScenarioV2.SIGN_IN, result.scenario)
+        assertEquals("sms-1", result.authMethods.single().id)
+        assertEquals("sms", result.authMethods.single().challengeChannel)
+    }
+
     @Test
     fun submitFirstFactorEmailCodeCanCompleteSignIn() = runTest {
         val state = codeRequiredState()
@@ -692,7 +711,7 @@ class NativeAuthV2SignInTest : PublicClientApplicationAbstractTest() {
     }
 
     // -----------------------------------------------------------------------------------------
-    // Email OTP MFA
+    // Email and SMS OTP MFA
     // -----------------------------------------------------------------------------------------
 
     @Test
@@ -717,6 +736,26 @@ class NativeAuthV2SignInTest : PublicClientApplicationAbstractTest() {
         assertEquals(NativeAuthFlowScenarioV2.SIGN_IN, result.scenario)
     }
 
+    @Test
+    fun signInV2WithPasswordCanTransitionToSmsMFA() = runTest {
+        enqueueResult(
+            NativeAuthV2CommandResult.MFARequired(
+                correlationId,
+                createContinuationState(),
+                listOf(NativeAuthV2AuthMethod("sms-1", "sms", "+X XXX XXX 34"))
+            ),
+            NativeAuthV2SignInStartCommand::class
+        )
+
+        val result = application.signInV2(signInParameters()) as NativeAuthResultV2.MFARequired
+        val method = result.authMethods.single()
+
+        assertEquals("sms-1", method.id)
+        assertEquals("sms", method.challengeChannel)
+        assertEquals("sms", method.challengeType)
+        assertEquals("+X XXX XXX 34", method.loginHint)
+    }
+
     @Test
     fun selectAuthMethodTransitionsToMFAVerificationRequired() = runTest {
         val state = mfaRequiredState()
@@ -740,6 +779,31 @@ class NativeAuthV2SignInTest : PublicClientApplicationAbstractTest() {
         assertEquals(NativeAuthFlowScenarioV2.SIGN_IN, result.scenario)
     }
 
+    @Test
+    fun selectSmsAuthMethodTransitionsToMFAVerificationRequired() = runTest {
+        val state = mfaRequiredState(
+            methods = listOf(NativeAuthV2AuthMethod("sms-1", "sms", "+X XXX XXX 34"))
+        )
+        enqueueResult(
+            NativeAuthV2CommandResult.MFAVerificationRequired(
+                correlationId,
+                createContinuationState(),
+                7,
+                "+X XXX XXX 34",
+                "sms"
+            ),
+            NativeAuthV2SelectMFAMethodCommand::class
+        )
+
+        val result = state.selectAuthMethod(state.authMethods.single()) as
+            NativeAuthResultV2.MFAVerificationRequired
+
+        assertEquals(7, result.codeLength)
+        assertEquals("+X XXX XXX 34", result.sentTo)
+        assertEquals("sms", result.channel)
+        assertEquals(NativeAuthFlowScenarioV2.SIGN_IN, result.scenario)
+    }
+
     @Test
     fun selectAuthMethodRejectsAMethodTheServerDidNotOffer() = runTest {
         val state = mfaRequiredState()
@@ -753,16 +817,15 @@ class NativeAuthV2SignInTest : PublicClientApplicationAbstractTest() {
     }
 
     @Test
-    fun selectAuthMethodRejectsAnUnsupportedChannelWithoutIssuingACommand() = runTest {
+    fun selectAuthMethodRejectsAnUnknownChannelWithoutIssuingACommand() = runTest {
         val state = mfaRequiredState(
-            methods = listOf(NativeAuthV2AuthMethod("sms-1", "sms", "+1***4567"))
+            methods = listOf(NativeAuthV2AuthMethod("voice-1", "voice", "+1***4567"))
         )
 
         val result = state.selectAuthMethod(state.authMethods.single())
 
         assertTrue(result is MFARequestChallengeErrorV2)
         val error = result as MFARequestChallengeErrorV2
-        // Distinguishable from an unspecified server error: this increment supports email only.
         assertTrue(error.isNotImplemented())
         assertFalse(error.isAuthMethodBlocked())
         assertFalse(error.isBrowserRequired())