feat: add support for email mfa

Sources/Authenticator/Authenticator.swift

@@ -15,6 +15,8 @@ public struct Authenticator<LoadingContent: View,
                             ConfirmSignInWithMFACodeContent: View,
                             ConfirmSignInWithTOTPCodeContent: View,
                             ContinueSignInWithMFASelectionContent: View,
+                            ContinueSignInWithMFASetupSelectionContent: View,
+                            ContinueSignInWithEmailMFASetupContent: View,
                             ContinueSignInWithTOTPSetupContent: View,
                             ConfirmSignInWithCustomChallengeContent: View,
                             SignUpContent: View,
@@ -40,7 +42,9 @@ public struct Authenticator<LoadingContent: View,
     private let confirmSignInContentWithMFACodeContent: ConfirmSignInWithMFACodeContent
     private let confirmSignInWithTOTPCodeContent: (ConfirmSignInWithCodeState) -> ConfirmSignInWithTOTPCodeContent
     private let continueSignInWithMFASelectionContent: (ContinueSignInWithMFASelectionState) -> ContinueSignInWithMFASelectionContent
+    private let continueSignInWithMFASetupSelectionContent: (ContinueSignInWithMFASetupSelectionState) -> ContinueSignInWithMFASetupSelectionContent
     private let continueSignInWithTOTPSetupContent: (ContinueSignInWithTOTPSetupState) -> ContinueSignInWithTOTPSetupContent
+    private let continueSignInWithEmailMFASetupContent: (ContinueSignInWithEmailMFASetupState) -> ContinueSignInWithEmailMFASetupContent
     private let confirmSignInContentWithCustomChallengeContent: ConfirmSignInWithCustomChallengeContent
     private let confirmSignInContentWithNewPasswordContent: ConfirmSignInWithNewPasswordContent
     private let signUpContent: SignUpContent
@@ -69,8 +73,12 @@ public struct Authenticator<LoadingContent: View,
     /// Defaults to a ``ConfirmSignInWithMFACodeView``.
     ///- Parameter continueSignInWithMFASelectionContent: The content associated with the ``AuthenticatorStep/continueSignInWithMFASelection`` step.
     /// Defaults to a ``ContinueSignInWithMFASelectionView``.
+    ///- Parameter continueSignInWithMFASetupSelectionContent: The content associated with the ``AuthenticatorStep/continueSignInWithMFASetupSelection`` step.
+    /// Defaults to a ``ContinueSignInWithMFASetupSelectionView``.
     ///- Parameter continueSignInWithTOTPSetupContent: The content associated with the ``AuthenticatorStep/continueSignInWithTOTPSetup`` step.
     /// Defaults to a ``ContinueSignInWithTOTPSetupView``.
+    ///- Parameter continueSignInWithEmailMFASetupContent: The content associated with the ``AuthenticatorStep/continueSignInWithEmailMFASetup`` step.
+    /// Defaults to a ``ContinueSignInWithEmailMFASetupView``.
     /// - Parameter confirmSignInWithCustomChallengeContent: The content associated with the ``AuthenticatorStep/confirmSignInWithCustomChallenge`` step.
     /// Defaults to a ``ConfirmSignInWithCustomChallengeView``.
     /// - Parameter confirmSignInWithNewPasswordContent: The content associated with the ``AuthenticatorStep/confirmSignInWithNewPassword`` step.
@@ -112,9 +120,15 @@ public struct Authenticator<LoadingContent: View,
         @ViewBuilder continueSignInWithMFASelectionContent: @escaping (ContinueSignInWithMFASelectionState) -> ContinueSignInWithMFASelectionContent = { state in
             ContinueSignInWithMFASelectionView(state: state)
         },
+        @ViewBuilder continueSignInWithMFASetupSelectionContent: @escaping (ContinueSignInWithMFASetupSelectionState) -> ContinueSignInWithMFASetupSelectionContent = { state in
+            ContinueSignInWithMFASetupSelectionView(state: state)
+        },
         @ViewBuilder continueSignInWithTOTPSetupContent: @escaping (ContinueSignInWithTOTPSetupState) -> ContinueSignInWithTOTPSetupContent = { state in
             ContinueSignInWithTOTPSetupView(state: state)
         },
+        @ViewBuilder continueSignInWithEmailMFASetupContent: @escaping (ContinueSignInWithEmailMFASetupState) -> ContinueSignInWithEmailMFASetupContent = { state in
+            ContinueSignInWithEmailMFASetupView(state: state)
+        },
         @ViewBuilder confirmSignInWithCustomChallengeContent: (ConfirmSignInWithCodeState) -> ConfirmSignInWithCustomChallengeContent = { state in
             ConfirmSignInWithCustomChallengeView(state: state)
         },
@@ -163,7 +177,9 @@ public struct Authenticator<LoadingContent: View,
 
         self.confirmSignInWithTOTPCodeContent = confirmSignInWithTOTPCodeContent
         self.continueSignInWithMFASelectionContent = continueSignInWithMFASelectionContent
+        self.continueSignInWithMFASetupSelectionContent = continueSignInWithMFASetupSelectionContent
         self.continueSignInWithTOTPSetupContent = continueSignInWithTOTPSetupContent
+        self.continueSignInWithEmailMFASetupContent = continueSignInWithEmailMFASetupContent
 
         let confirmSignInWithCustomChallengeState = ConfirmSignInWithCodeState(credentials: credentials)
         contentStates.add(confirmSignInWithMFACodeState)
@@ -344,18 +360,29 @@ public struct Authenticator<LoadingContent: View,
                 allowedMFATypes: allowedMFATypes
             )
             continueSignInWithMFASelectionContent(continueSignInWithMFASelection)
+        case .continueSignInWithMFASetupSelection(let allowedMFATypes):
+            let continueSignInWithMFASetupSelection = ContinueSignInWithMFASetupSelectionState(
+                authenticatorState: state,
+                allowedMFATypes: allowedMFATypes
+            )
+            continueSignInWithMFASetupSelectionContent(continueSignInWithMFASetupSelection)
         case .confirmSignInWithTOTPCode:
             let confirmSignInWithCodeState = ConfirmSignInWithCodeState(
                 authenticatorState: state
             )
             confirmSignInWithTOTPCodeContent(confirmSignInWithCodeState)
         case .continueSignInWithTOTPSetup(let totpSetupDetails):
-            let totpStupState = ContinueSignInWithTOTPSetupState(
+            let totpSetupState = ContinueSignInWithTOTPSetupState(
                 authenticatorState: state,
                 issuer: totpOptions.issuer,
                 totpSetupDetails: totpSetupDetails
             )
-            continueSignInWithTOTPSetupContent(totpStupState)
+            continueSignInWithTOTPSetupContent(totpSetupState)
+        case .continueSignInWithEmailMFASetup:
+            let emailMFASetupState = ContinueSignInWithEmailMFASetupState(
+                authenticatorState: state
+            )
+            continueSignInWithEmailMFASetupContent(emailMFASetupState)
         case .confirmSignInWithCustomChallenge:
             confirmSignInContentWithCustomChallengeContent
         case .resetPassword:

Sources/Authenticator/Models/AuthenticatorStep.swift

@@ -58,6 +58,14 @@ public struct AuthenticatorStep: Equatable {
     /// so they are presented with the Confirm Sign In with MFA Selection View
     public static let continueSignInWithMFASelection = AuthenticatorStep("continueSignInWithMFASelection")
 
+    /// A user has successfully provided valid Sign In credentials but is required to select  a MFA type to continue
+    /// so they are presented with the Confirm Sign In with MFA Selection View
+    public static let continueSignInWithMFASetupSelection = AuthenticatorStep("continueSignInWithMFASetupSelection")
+
+    /// A user has successfully provided valid Sign In credentials but is required to setup TOTP before continuing sign in
+    /// so they are presented with the  TOTP Setup View
+    public static let continueSignInWithEmailMFASetup = AuthenticatorStep("continueSignInWithEmailMFASetup")
+
     /// A user has successfully provided valid Sign In credentials but is required to provide a MFA code,
     /// so they are presented with the Confirm Sign In with MFA Code view
     public static let confirmSignInWithMFACode = AuthenticatorStep("confirmSignInWithMFACode")

Sources/Authenticator/Models/Internal/Step.swift

@@ -15,6 +15,8 @@ enum Step {
     case confirmSignInWithCustomChallenge
     case confirmSignInWithTOTPCode
     case continueSignInWithMFASelection(allowedMFATypes: AllowedMFATypes)
+    case continueSignInWithMFASetupSelection(allowedMFATypes: AllowedMFATypes)
+    case continueSignInWithEmailMFASetup
     case continueSignInWithTOTPSetup(totpSetupDetails: TOTPSetupDetails)
     case confirmSignInWithMFACode(deliveryDetails: AuthCodeDeliveryDetails?)
     case confirmSignInWithNewPassword
@@ -55,6 +57,10 @@ enum Step {
             return .continueSignInWithTOTPSetup
         case .continueSignInWithMFASelection:
             return .continueSignInWithMFASelection
+        case .continueSignInWithMFASetupSelection:
+            return .continueSignInWithMFASetupSelection
+        case .continueSignInWithEmailMFASetup:
+            return .continueSignInWithEmailMFASetup
         case .confirmSignInWithMFACode:
             return .confirmSignInWithMFACode
         case .confirmSignInWithNewPassword:

Sources/Authenticator/Resources/en.lproj/Localizable.strings

@@ -85,10 +85,23 @@
 "authenticator.confirmSignInWithCode.totp.button.submit" = "Confirm";
 "authenticator.confirmSignInWithCode.totp.button.backToSignIn" = "Back to Sign In";
 
+/* Continue Sign In with MFA Setup Selection */
+"authenticator.continueSignInWithMFASetupSelection.email.radioButton.title" = "Email";
+"authenticator.continueSignInWithMFASetupSelection.totp.radioButton.title" = "Authenticator App (TOTP)";
+"authenticator.continueSignInWithMFASetupSelection.button.continue" = "Continue";
+"authenticator.continueSignInWithMFASetupSelection.title" = "Select your preferred Two-Factor Auth method to set up";
+"authenticator.continueSignInWithMFASetupSelection.button.backToSignIn" = "Back to Sign In";
+
+/* Continue Sign In with Email MFA Setup */
+"authenticator.continueSignInWithEmailMFASetup.title" = "Enter your email for setting up Two-Factor Auth method";
+"authenticator.continueSignInWithEmailMFASetup.button.continue" = "Continue";
+"authenticator.continueSignInWithEmailMFASetup.button.backToSignIn" = "Back to Sign In";
+
 /* Continue Sign In with MFA Selection */
 "authenticator.continueSignInWithMFASelection.title" = "Select your preferred Two-Factor Auth method";
 "authenticator.continueSignInWithMFASelection.sms.radioButton.title" = "Text Message (SMS)";
 "authenticator.continueSignInWithMFASelection.totp.radioButton.title" = "Authenticator App (TOTP)";
+"authenticator.continueSignInWithMFASelection.email.radioButton.title" = "Email";
 "authenticator.continueSignInWithMFASelection.button.submit" = "Continue";
 "authenticator.continueSignInWithMFASelection.button.backToSignIn" = "Back to Sign In";
 

Sources/Authenticator/States/AuthenticatorBaseState.swift

@@ -67,7 +67,8 @@ public class AuthenticatorBaseState: ObservableObject {
     func nextStep(for result: AuthSignInResult) async throws -> Step {
         log.verbose("Sign In next step is \(result.nextStep)")
         switch result.nextStep {
-        case .confirmSignInWithSMSMFACode(let details, _):
+        case .confirmSignInWithSMSMFACode(let details, _),
+                .confirmSignInWithEmailMFACode(let details):
             return .confirmSignInWithMFACode(deliveryDetails: details)
         case .confirmSignInWithCustomChallenge(_):
             return .confirmSignInWithCustomChallenge
@@ -116,6 +117,10 @@ public class AuthenticatorBaseState: ObservableObject {
             return .continueSignInWithMFASelection(allowedMFATypes: allowedMFATypes)
         case .continueSignInWithTOTPSetup(let totpSetupDetails):
             return .continueSignInWithTOTPSetup(totpSetupDetails: totpSetupDetails)
+        case .continueSignInWithMFASetupSelection(let allowedMFATypes):
+            return .continueSignInWithMFASetupSelection(allowedMFATypes: allowedMFATypes)
+        case .continueSignInWithEmailMFASetup:
+            return .continueSignInWithEmailMFASetup
         default:
             throw AuthError.unknown("Unsupported next step: \(result.nextStep)", nil)
         }

Sources/Authenticator/States/ContinueSignInWithEmailMFASetupState.swift

@@ -0,0 +1,52 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Amplify
+import AWSCognitoAuthPlugin
+import SwiftUI
+
+/// The state observed by the Continue Sign In with Email MFA Setup Challenge, representing the ``Authenticator`` is in either the ``AuthenticatorStep/continueSignInWithEmailMFASetup``
+public class ContinueSignInWithEmailMFASetupState: AuthenticatorBaseState {
+    /// The confirmation code provided by the user
+    @Published public var email: String = ""
+
+    override init(credentials: Credentials) {
+        super.init(credentials: credentials)
+    }
+
+    init(authenticatorState: AuthenticatorStateProtocol) {
+        super.init(authenticatorState: authenticatorState,
+                   credentials: Credentials())
+    }
+
+    /// Attempts to continue user's sign by providing email.
+    ///
+    /// Automatically sets the Authenticator's next step accordingly, as well as the
+    /// ``AuthenticatorBaseState/isBusy`` and ``AuthenticatorBaseState/message`` properties.
+    /// - Throws: An `Amplify.AuthenticationError` if the operation fails
+    public func continueSignIn() async throws {
+        setBusy(true)
+
+        do {
+            log.verbose("Attempting to continue Sign In with Email setup")
+            let result = try await authenticationService.confirmSignIn(
+                challengeResponse: email,
+                options: nil
+            )
+            let nextStep = try await nextStep(for: result)
+
+            setBusy(false)
+
+            authenticatorState.setCurrentStep(nextStep)
+        } catch {
+            log.error("Continue Sign In with Email MFA Setup failed")
+            let authenticationError = self.error(for: error)
+            setMessage(authenticationError)
+            throw authenticationError
+        }
+    }
+}

Sources/Authenticator/States/ContinueSignInWithMFASetupSelectionState.swift

@@ -0,0 +1,58 @@
+//
+// Copyright Amazon.com Inc. or its affiliates.
+// All Rights Reserved.
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+import Amplify
+import AWSCognitoAuthPlugin
+import SwiftUI
+
+/// The state observed by the Continue Sign In With MFA Setup Selection content views, representing the ``Authenticator`` is in  ``AuthenticatorStep/continueSignInWithMFASetupSelection``  step.
+public class ContinueSignInWithMFASetupSelectionState: AuthenticatorBaseState {
+
+    /// The MFA type selected by the user
+    @Published public var selectedMFATypeToSetup: MFAType?
+
+    init(authenticatorState: AuthenticatorStateProtocol,
+         allowedMFATypes: AllowedMFATypes) {
+        self.allowedMFATypes = allowedMFATypes
+        super.init(authenticatorState: authenticatorState,
+                   credentials: Credentials())
+    }
+
+    /// The `Amplify.AllowedMFATypes` associated with this state.
+    public let allowedMFATypes: AllowedMFATypes
+
+    /// Attempts to continue the user's sign in using the provided MFA type to setup.
+    ///
+    /// Automatically sets the Authenticator's next step accordingly, as well as the
+    /// ``AuthenticatorBaseState/isBusy`` and ``AuthenticatorBaseState/message`` properties.
+    /// - Throws: An `Amplify.AuthenticationError` if the operation fails
+    public func continueSignIn() async throws {
+        guard let selectedMFATypeToSetup = selectedMFATypeToSetup else {
+            log.error("MFA type not selected")
+            return
+        }
+
+        setBusy(true)
+        do {
+            log.verbose("Attempting to continue Sign In with selected MFA type to setup")
+            let result = try await authenticationService.confirmSignIn(
+                challengeResponse: selectedMFATypeToSetup.challengeResponse,
+                options: nil
+            )
+            let nextStep = try await nextStep(for: result)
+
+            setBusy(false)
+
+            authenticatorState.setCurrentStep(nextStep)
+        } catch {
+            log.error("Continue Sign In with MFA Setup Selection failed")
+            let authenticationError = self.error(for: error)
+            setMessage(authenticationError)
+            throw authenticationError
+        }
+    }
+}

Sources/Authenticator/Views/ConfirmSignInWithMFACodeView.swift

@@ -76,4 +76,3 @@ public struct ConfirmSignInWithMFACodeFooter: View {
         .buttonStyle(.link)
     }
 }
-